Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix bug with PnL aggregation. #2446

Merged
merged 1 commit into from
Oct 3, 2024
Merged

Conversation

vincentwschau
Copy link
Contributor

@vincentwschau vincentwschau commented Oct 3, 2024

Changelist

PnL aggregation was by block, however PnL ticks can be generated for the same hour at separate block heights (seconds to minutes apart).
Instead, aggregate PnL ticks by hour.

Test Plan

Unit tests.

Author/Reviewer Checklist

  • If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
  • If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
  • If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
  • If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
  • If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
  • Manually add any of the following labels: refactor, chore, bug.

Summary by CodeRabbit

  • New Features

    • Introduced hourly aggregation for Profit and Loss (PnL) ticks, enhancing data granularity.
  • Bug Fixes

    • Updated test cases to reflect new aggregation logic and ensure accurate results.
  • Documentation

    • Improved comments and documentation within the code to clarify changes in aggregation methods and data structures.

@vincentwschau vincentwschau requested a review from a team as a code owner October 3, 2024 02:04
Copy link
Contributor

coderabbitai bot commented Oct 3, 2024

Walkthrough

The pull request introduces significant modifications to the handling of Profit and Loss (PnL) ticks across multiple files. Key changes include the renaming of the aggregatePnlTicks function to aggregateHourlyPnlTicks, reflecting a shift to hourly aggregation. The data structure for aggregated results has transitioned from a Map to an array, affecting how results are processed and returned. Additionally, the use of the DateTime library from luxon has been integrated for improved time handling in the aggregation logic. Test cases have also been updated to align with these changes.

Changes

File Path Change Summary
indexer/services/comlink/__tests__/lib/helpers.test.ts Renamed aggregatePnlTicks to aggregateHourlyPnlTicks. Updated test cases for new aggregation logic, including expected outputs and data structure. Added DateTime handling.
indexer/services/comlink/src/controllers/api/v4/historical-pnl-controller.ts Replaced aggregatePnlTicks with aggregateHourlyPnlTicks in getHistoricalPnlForParentSubaccount. Changed aggregatedPnlTicks type from Map to array. Updated return statement accordingly.
indexer/services/comlink/src/controllers/api/v4/vault-controller.ts Renamed aggregatePnlTicks to aggregateHourlyPnlTicks. Updated filterOutIntervalTicks to accept an array instead of a Map. Adjusted comments for clarity.
indexer/services/comlink/src/lib/helpers.ts Renamed aggregatePnlTicks to aggregateHourlyPnlTicks. Modified aggregation logic to truncate timestamps to the hour using DateTime. Changed return type to an array.

Possibly related PRs

Suggested labels

indexer, feature:indexer/affiliates

🐰 In the fields where PnL ticks play,
We’ve changed the game in a bright new way.
From maps to arrays, we now align,
With hourly data, our results will shine.
So hop along, let’s test and see,
The magic of numbers, as clear as can be! 🌼


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

🧹 Outside diff range and nitpick comments (1)
indexer/services/comlink/__tests__/lib/helpers.test.ts (1)

883-895: Clarify time calculations for better readability

In the test case, blockTime3 is calculated by adding 61 minutes to pnlTick.createdAt:

const blockTime3: string = DateTime.fromISO(pnlTick.createdAt).plus({ minute: 61 }).toISO();

Adding 61 minutes achieves the desired time offset, but it might be clearer to add { hour: 1, minute: 1 } to represent 1 hour and 1 minute explicitly. This enhances readability and reduces the potential for confusion.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 922a9b5 and b09d49c.

📒 Files selected for processing (4)
  • indexer/services/comlink/tests/lib/helpers.test.ts (5 hunks)
  • indexer/services/comlink/src/controllers/api/v4/historical-pnl-controller.ts (2 hunks)
  • indexer/services/comlink/src/controllers/api/v4/vault-controller.ts (3 hunks)
  • indexer/services/comlink/src/lib/helpers.ts (2 hunks)
🔇 Additional comments (9)
indexer/services/comlink/src/controllers/api/v4/historical-pnl-controller.ts (5)

22-22: LGTM: Import statement updated correctly.

The import statement has been updated to include aggregateHourlyPnlTicks instead of aggregatePnlTicks, which aligns with the PR objective of modifying the PnL aggregation method.


159-159: LGTM: Aggregation function updated to group by hour.

The change from aggregatePnlTicks to aggregateHourlyPnlTicks aligns with the PR objective of grouping PnL ticks by hour instead of by block. This should address the issue of inaccurate PnL aggregation due to ticks being generated at different block heights within the same hour.


159-159: Verify performance impact of new data structure.

The change from Map<number, PnlTicksFromDatabase> to PnlTicksFromDatabase[] represents a shift in the data structure. While this change is necessary for the new aggregation method, it's important to verify that it doesn't negatively impact performance or memory usage, especially for large datasets.

Could you provide some benchmarks or performance tests comparing the old and new implementations, particularly for scenarios with a large number of PnL ticks?


Line range hint 162-166: LGTM: historicalPnl construction updated correctly.

The historicalPnl construction has been appropriately updated to directly map over the aggregatedPnlTicks array. This change is consistent with the new data structure and should maintain the correct functionality.


Line range hint 1-266: Summary: Changes address the PnL aggregation issue, but require further verification.

The modifications to the getHistoricalPnlForParentSubaccount method successfully implement the new hourly PnL aggregation, addressing the issue of inaccurate aggregation due to block-based grouping. The changes are well-implemented and consistent with the PR objectives.

However, to ensure the robustness and efficiency of these changes, please address the following points:

  1. Provide benchmarks or performance tests comparing the old and new implementations, especially for large datasets, to verify that the change in data structure (from Map to Array) doesn't negatively impact performance or memory usage.

  2. Implement comprehensive unit tests to ensure the new aggregation method works as expected across various scenarios, including edge cases.

  3. Update the relevant documentation to reflect the changes in PnL aggregation methodology.

Could you please provide information on the test plan implementation and any performance comparisons you've conducted?

indexer/services/comlink/src/controllers/api/v4/vault-controller.ts (1)

96-96: Updated to use hourly PnL aggregation

Great job updating the code to use aggregateHourlyPnlTicks for hourly aggregation of PnL ticks. This aligns well with the PR objective to aggregate PnL ticks by hour instead of by block.

indexer/services/comlink/src/lib/helpers.ts (1)

687-687: Ensure consistent time zone handling when truncating timestamps.

Using DateTime.fromISO(pnlTick.createdAt).startOf('hour').toISO() relies on the default time zone, which may lead to inconsistent aggregation if createdAt timestamps are not in UTC. Explicitly specifying the time zone can prevent potential issues.

Run the following script to check if all createdAt timestamps are in UTC:

✅ Verification successful

Consistent UTC time zone handling verified for createdAt timestamps.

All createdAt fields are in UTC, ensuring consistent aggregation.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that all `createdAt` timestamps in PnL ticks are in UTC.

# Test: Search for `createdAt` values with time zone offsets. Expect: No matches if all are in UTC.
rg --type js --no-heading --no-filename 'createdAt:\s*"[^"]+"' | grep -E '\+\d{2}:\d{2}|\-\d{2}:\d{2}'

Length of output: 104


Script:

#!/bin/bash
# Description: Verify that all `createdAt` timestamps in PnL ticks are in UTC by checking for 'Z' suffix.

# Test: Search for `createdAt` values not ending with 'Z'. Expect: No matches if all are in UTC.
rg --type js 'createdAt:\s*"[^"]+[^Z]"'

Length of output: 41


Script:

#!/bin/bash
# Description: Check for `createdAt` fields without any time zone information.

# Test: Search for `createdAt` values without time zone offset or 'Z'. Expect: Minimal or no matches.
rg --type js 'createdAt:\s*"[^"]+(?<!Z)"'

Length of output: 293

indexer/services/comlink/__tests__/lib/helpers.test.ts (2)

47-47: Import of 'aggregateHourlyPnlTicks' is appropriate

The addition of aggregateHourlyPnlTicks to the import statement is necessary for the new test cases.


63-63: Importing 'DateTime' from 'luxon' is necessary

The import of DateTime from the luxon library correctly facilitates date and time manipulations in the test cases.

@vincentwschau vincentwschau merged commit 8fdf8c5 into main Oct 3, 2024
16 checks passed
@vincentwschau vincentwschau deleted the vincentc/fix-pnl-aggregation-bug branch October 3, 2024 15:15
@vincentwschau
Copy link
Contributor Author

@Mergifiyio backport release/indexer/v7.x

mergify bot pushed a commit that referenced this pull request Oct 3, 2024
vincentwschau added a commit that referenced this pull request Oct 3, 2024
@coderabbitai coderabbitai bot mentioned this pull request Dec 17, 2024
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

2 participants